Server-Side Mobile Client Attestation Library/at.asitplus.attestation

Package-level declarations

Types

Pairs an Apple AppAttest assertion with the referenced clientData value

sealed class AttestationException : Throwable

Provides additional details on why an attestation attempt failed, indicating which platform was being attested. Although many reasons exist, why an attestation may fail, these can be put into two categories:

AttestationObject

data class AttestationObject(val fmt: String, val attStmt: AttestationObject.AttestationStatement, val authData: ByteArray)

AttestationResult

sealed class AttestationResult

Attestation result class. Successful results contain attested data. Typically contained within a KeyAttestation object.

AttestationService

abstract class AttestationService

DefaultAttestationService

class DefaultAttestationService(androidAttestationConfiguration: AndroidAttestationConfiguration, iosAttestationConfiguration: IOSAttestationConfiguration, clock: Clock = Clock.System, verificationTimeOffset: Duration = Duration.ZERO) : AttestationService

Default, functional Android Key Attestation and Apple App Attestation in all its glory.

IOSAttestationConfiguration

data class IOSAttestationConfiguration @JvmOverloads constructor(val applications: List<IOSAttestationConfiguration.AppData>, val iosVersion: String? = null)

Configuration class for Apple App Attestation

KeyAttestation

data class KeyAttestation<T : PublicKey>

Result type returned by AttestationService.verifyKeyAttestation. attestedPublicKey contains attested public key if attestation was successful (null otherwise) details contains the detailed attestation result (see AttestationResult for more details)

NoopAttestationService

object NoopAttestationService : AttestationService

NOOP attestation service. Useful during unit tests for disabling attestation integrated into service endpoints. Simply forwards inputs but performs no attestation whatsoever.

Platform

enum Platform : Enum<Platform>

Functions

parseToCertificate

fun ByteArray.parseToCertificate(): X509Certificate?

parseToPublicKey

fun ByteArray.parseToPublicKey(): PublicKey

toAnsi

fun ECPublicKey.toAnsi(): ByteArray

toKotlinClock

fun Clock.toKotlinClock(): Clock